home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / pcb / ttp22.zip / TIC2PCB.DOC < prev    next >
Text File  |  1992-12-27  |  17KB  |  420 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.      ▀▀▀▀█▀▀▀▀                  ▄▀▀▄            ▀█▀▀▀▀█ █▀▀▀▀█ ▀█▀▀▀▀█
  8.          █                     ▀    █            █    █ █       █    █
  9.          █   ▀ █▀▀▀▀              ▄▀             █▄▄▄▄█ █       █▄▄▄▄▀
  10.          █   █ █        ▀▀▀     ▄▀       ▀▀▀     █      █       █    █
  11.          █   █ █▄▄▄▄           █▄▄▄▄▄           ▄█▄     █▄▄▄▄█ ▄█▄▄▄▄█
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                                Version 2.2
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.                                 Copyright (C) 1992
  42.                                         by
  43.                                     Tom Carroll
  44.  
  45.  
  46.                                 All rights reserved
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.                                  The Data Shop BBS
  55.                             (509)582-9493 (16.8k HST/DS)
  56.                                    Kennewick, WA
  57.                               FIDO address (1:347/10)
  58.  
  59.                               MAGIC FILE NAME: TIC2PCB
  60.     ┌──────────────┐
  61.     │ INTRODUCTION │
  62.     └──────────────┘
  63.  
  64.     Tic-2-PCB was written because I wanted a program that would be very easy to
  65.     configure, and that would move the new files I get from time to time off the
  66.     FIDO SDN networks to my uploads directory.  I looked at the program called
  67.     TICK, but again, it was a program that required an extensive configuration
  68.     file, and it was very hard to understand the formatting of the directory
  69.     entries, hence, Tic-2-PCB was developed.
  70.  
  71.     ┌──────────────┐
  72.     │  DISCLAIMER  │
  73.     └──────────────┘
  74.  
  75.     This software is provided without any guarantee or warranty either expressed
  76.     or implied.  I will not be held responsible for ANY damages that may result
  77.     in the use of this program.  "ANY" means if you install it, run it, and it
  78.     eats your programs that you've been working on for 2 years without a backup,
  79.     IT'S NOT MY FAULT!!!
  80.  
  81.     Tic-2-PCB software and this document are Copyright (C) 1992 by Tom Carroll. 
  82.     All rights reserved.
  83.  
  84.     ┌──────────────┐
  85.     │   LICENSE    │
  86.     └──────────────┘
  87.  
  88.     This program is being released as FREEWARE.  The source code will remain
  89.     the property of the author unless otherwise released by him.
  90.  
  91.     You are free to use this version of the program without any cost of
  92.     registration.  This however, may change at any time with a new version
  93.     release. (If this should happen, a one time registration fee will be asked)
  94.  
  95.     No one may alter, modify, or reverse engineer Tic-2-PCB for any reason,
  96.     including but not limited to decompiling-compiling, patching, or
  97.     disassembling.
  98.  
  99.     You may freely distribute & copy this program for others subject to the
  100.     above restrictions and the following:
  101.  
  102.          ■ Tic-2-PCB is copied in unmodified form including this file. 
  103.          ■ There is no charge for copying except for the cost of disks.
  104.          ■ Tic-2-PCB is not included in another software package without
  105.            the express written permission of Tom Carroll.
  106.  
  107.     ┌──────────────┐
  108.     │   SUPPORT    │
  109.     └──────────────┘
  110.  
  111.     If you should find any problems with this program, or you have any requests
  112.     or recommendations, you may reach me on my BBS, or at the FIDO address
  113.     listed on the front cover.  I may also be reached in the QUIK_BAS & PCBNET
  114.     FIDO echo's, UNI', ILink, and Global Link Sysop conferences, or on SaltAir.
  115.  
  116.     Tic-2-PCB Supports .TIC files from most file echo systems.
  117.  
  118.  
  119.     Tic-2-PCB v2.2                                                       Page 2
  120.     ┌──────────────┐
  121.     │  THE AUTHOR  │
  122.     └──────────────┘
  123.  
  124.     This was my first public program.
  125.  
  126.     I have been writing in BASIC for about 7 years, and I really like it, but 
  127.     I've been planning on taking a course in "C", but still haven't...
  128.  
  129.     I am presently active duty in the U.S. Coast Guard, and have been a "Sysop"
  130.     for their computer systems at my duty stations for about 6 years.
  131.  
  132.     I would like to thank my wife, who always says "Are you coming to bed, or
  133.     are you going to keep PLAYING on that computer?"
  134.  
  135.     ┌──────────────┐
  136.     │    FILES     │
  137.     └──────────────┘
  138.  
  139.     Files included in this archive:
  140.  
  141.               FILE_ID.DIZ  - Description file for Tic-2-PCB
  142.               PROGRAMS.DWS - List of Dataware Software products
  143.               SAMPLE.CFG   - Sample configuration file
  144.               SAMPLE.LOG   - Sample log file
  145.               TIC2PCB.DOC  - This manual
  146.               TIC2PCB.HIS  - Tic-2-PCB's metamorphosis
  147.               TIC2PCB.EXE  - The heart of the game...
  148.               TIC2PCB.SCR  - Color image overlay
  149.               TIC2PCB.SC1  - Mono image overlay
  150.  
  151.     I originally compressed this program as TTPnn.ARJ, but it may be
  152.     compressed with any other archive program you wish to use as long as all
  153.     the above listed files are included within the new archive.
  154.  
  155.     The latest version will always be available on my BBS using the magic
  156.     filename of TIC2PCB or in conference #1 (Dataware Support).
  157.  
  158.     Sometimes, there may be a need for debug code to be released.  This code is
  159.     used to track down specific problems which aren't normally encountered on
  160.     my system.  I have a 386/sx-25 w/4megs of RAM, and DOS 5.0, which should be
  161.     pretty standard and generic, but sometimes this doesn't present an optimal
  162.     testing environment, so please, if you're having problems, and debug code
  163.     is available, feel free to FREQ DEBUG from me, or if you're registered on
  164.     my BBS call and download TIC2PCB.ARJ from conference #1.  If it's not
  165.     available, then you're the first person that has reported a problem, so
  166.     please leave me your specifics, and also your config file so I may be able
  167.     to trouble shoot the problem.
  168.  
  169.  
  170.     
  171.     
  172.     
  173.     Now, on with the installation...
  174.  
  175.  
  176.  
  177.  
  178.     
  179.     Tic-2-PCB v2.2                                                       Page 3
  180.     ┌──────────────┐
  181.     │    SETUP     │
  182.     └──────────────┘
  183.  
  184.     All you need to do is complete the small configuration file.  The config
  185.     file is based on a KEYWORD <SPACE> {OPTION} format.  The file is pretty
  186.     much order independent except for the AREA declarations.  You can check
  187.     the included SAMPLE.CFG to see the simple formatting used.
  188.  
  189.     Here are the KEYWORDS and their use:
  190.  
  191.     INBOUND   *Location where your inbound files will be located.
  192.     DEFDOS    *Location where you want your ARCHIVE placed if there's not
  193.                an AREA declaration for it.
  194.     DEFPCB    *Name of the PCBoard(tm) directory listing to update for
  195.                ARCHIVES which don't have an AREA declaration.
  196.     DLTXT     *Name and location of your PCBoard(tm) DOWNLOAD.TXT file.
  197.     TEST      Name and location of a batch file to be called so you may call
  198.               an upload processor to test each file after it's imported.
  199.               (NOTE: if the keyword @TEST is used, Tic-2-PCB will make a
  200.                list file and pass that as parameter %1 instead of a single
  201.                file name.)
  202.     COPYARC   Tells Tic-2-PCB to copy the archive instead of move it.
  203.     KEEPTIC   Prevents Tic-2-PCB from deleting all the .TIC files.
  204.     FILEDATE  Makes Tic-2-PCB use the ARCHIVE date instead of the system
  205.               date for the PCBoard(tm) DIR file listing.
  206.     LOGOFF    Turns off the standard TIC2PCB.LOG creation/appending.
  207.     NOINFO    Stops the adding of "Received by Tic-2-PCB" lines in the
  208.               PCBoard(tm) DIR files.
  209.     NODIZ     +Do not check for the FILE_ID.DIZ or DESC.SDI files within the
  210.               archives.
  211.     NOCRC     Do not compare the included CRC-32 with the ARCHIVE CRC-32.
  212.     UNKNOWN   ~Allow files from unknown areas to be imported to the default
  213.               DOS & PCB DIRS.
  214.     AREA      ~Name of the AREA you will be receiving files from.
  215.     DOSDIR    ~Name of the DOS directory you want the ARCHIVEs placed.
  216.     PCBDIR    ~PCBoard(tm) DIR file you want updated for the ARCHIVE
  217.               description.
  218.     PASSWORD  ~Checks the Password in the .TIC files against the one listed
  219.               for the AREA.  PW checking is disabled if the KEYWORD is not
  220.               present.
  221.  
  222.     * - Required items
  223.     ~ - If the UNKNOWN KEYWORD is present, the AREA declarations are optional
  224.     + - Requires the following archive utilities to be somewhere in your path
  225.         or in the same directory as Tic-2-PCB:
  226.     
  227.         ARC - ARC by System Enhancement Associates, Inc.
  228.         ARJ - ARJ by Robert K. Jung
  229.         LHA - LHARC by Haruyasu Yoshizaki
  230.         PAK - PAK by NoGate Consulting
  231.         ZIP - PKZip by PKWare, Inc.
  232.         ZOO - ZOO by Rahul Dhesi
  233.     
  234.     Any errors encountered in the configuration file are reported immediately,
  235.     and logged to a file called TIC2PCB.ERR.  Tic-2-PCB will check each line of
  236.     the configuration file and ensure it's correct before beginning execution.
  237.  
  238.     
  239.     Tic-2-PCB v2.2                                                       Page 4
  240.     ┌──────────────┐
  241.     │  OPERATION   │
  242.     └──────────────┘
  243.  
  244.     If an error is encountered, Tic-2-PCB will halt execution and exit with an
  245.     errorlevel of 1.
  246.     
  247.     Now, all you need to do is execute TIC2PCB.EXE and give it the config file
  248.     name.  (i.e.  TIC2PCB MYCONFIG.CFG)  Also, there are two command line
  249.     switches that may be used by Tic-2-PCB.  /BELL and /M.  /BELL will turn
  250.     off the bell when an error is encountered.  /M will force Tic-2-PCB's
  251.     output routines into Monochrome mode.
  252.  
  253.     Tic-2-PCB will update your DOWNLOAD.TXT file (or whatever you call it), and
  254.     will make the following entry:
  255.  
  256.     (U),TIC-2-PCB AREANAME,MM-DD-YYYY,HH:MM,FILENAME.EXT,L,0,9600
  257.     
  258.     This entry just tells your File Profilers that an upload by Tic-2-PCB of
  259.     a file from AREANAME on that date & time consisted of FILENAME.EXT, using
  260.     the L protocol (I used the L protocol to signify a local upload) with no
  261.     errors, with an average speed of 9600 CPS.
  262.  
  263.     There will be one log file created if it doesn't exist (should you not
  264.     disable that option) called TIC2PCB.LOG.  It will be in the following
  265.     format:
  266.     
  267.              --------[ Processing {INBOUND} - MM-DD-YYYY - HH:MM:SS
  268.              --------[ Process complete - MM-DD-YYYY - HH:MM:SS
  269.              --------[ Process Aborted! - MM-DD-YYYY - HH:MM:SS
  270.              A - Area unknown for file specified
  271.                  Renamed .TIC to .UNK
  272.              C - CRC check sum error on archive
  273.                  Renamed .TIC to .CRC
  274.              D - FILE_ID.DIZ is longer than 450 bytes - Not used
  275.              E - Error encountered in .TIC file
  276.                  Renamed .TIC to .ERR
  277.              F - File doesn't exist
  278.                  Renamed .TIC to .FIL
  279.              P - Incorrect password for AREA
  280.                  Renamed .TIC to .PWD
  281.              S - DESC.SDI longer than 85 bytes - Not used
  282.              √ - Process successful.  File imported properly
  283.  
  284.     I recommend deleting this file, or not using it at all if you move or
  285.     receive a lot of files through FIDO.  In any case, should you use it, be
  286.     sure to check the size of it every now and then.  If you don't want the
  287.     logging, just add the LOGOFF keyword to the config file.
  288.  
  289.     When Tic-2-PCB has executed successfully, it will exit with an errorlevel
  290.     set to 0.  If an error is encountered during execution, it will exit with
  291.     an errorlevel of 1, and create a file called TIC2PCB.ERR.  If it should
  292.     encounter an unexpected error, it will exit with an errorlevel set to 2.
  293.  
  294.     
  295.     
  296.     
  297.     
  298.     
  299.     Tic-2-PCB v2.2                                                       Page 5
  300.     When a file is received that isn't in any of your AREA declarations, and
  301.     you have the UNKNOWN keyword in the config file it will be imported into
  302.     the default directory and DIR file listed in lines DEFDOS & DEFPCB.  The
  303.     "Received by Tic-2-PCB xx-xx-xx from AREANAME" in the default DIR listing
  304.     will show the area it was actually received from.
  305.     
  306.     Here is an excerpt of my RUN.BAT file which shows how I process my tick
  307.     files:
  308.  
  309.     CD \FD
  310.     REM           ---------  CHECK FOR NEW FILES    ---------
  311.     IF TIC2PCB TIC2PCB.CFG <options>
  312.  
  313.     That's it, you shouldn't have to do anything else, but fire it up and see
  314.     how easy and quick it actually is.
  315.  
  316.     ┌──────────────┐
  317.     │    NOTES     │
  318.     └──────────────┘
  319.  
  320.     Please remember that the speed factor will be reduced if you have logging,
  321.     check for DIZ, or check CRC-32 turned on, otherwise Tic-2-PCB will import
  322.     approximately 1.5 files per second if it is only moving the archives from
  323.     one directory to another on the same drive.
  324.     
  325.     You may find several TICK files within your inbound directory with the
  326.     following extensions:
  327.  
  328.          TKnnnnnn.ERR - An error was encountered within the .TIC file.
  329.                         This will be caused by trashed files, or a non-
  330.                         standard format for the .TIC file.  The archive
  331.                         is NOT processed into the system.  Please notify
  332.                         me if you have these appear on your system.
  333.  
  334.          TKnnnnnn.FIL - The listed archive within the .TIC file doesn't exist.
  335.                         This could be the cause of another file processor 
  336.                         moving/deleting the archive before Tic-2-PCB processed
  337.                         it into the system, or you have the KEEPTIC keyword
  338.                         listed in your config file and Tic-2-PCB is re-
  339.                         processing the .TIC files.
  340.  
  341.          TKnnnnnn.PWD - An incorrect password was encountered within the .TIC
  342.                         file.  The archive was not processed into the system.
  343.                         This could be caused by an incorrect password listed
  344.                         within the config file for the AREA name, or you have
  345.                         changed your RAID password on your host node.
  346.  
  347.          TKnnnnnn.CRC - An invalid check sum was found in the .TIC file for
  348.                         the listed archive.  The archive was not processed
  349.                         into the system.  This will be caused by a someone
  350.                         changing the archive format, or tampering with the
  351.                         original archive release.
  352.  
  353.          TKnnnnnn.UNK - An unknown AREA was found in the .TIC file for the
  354.                         listed archive.  The archive was not processed into
  355.                         the system.  This will be caused by receiving a new
  356.                         file echo and not having an AREA definition for it, 
  357.                         or not having the UNKNOWN keyword in the config file.
  358.  
  359.     Tic-2-PCB v2.2                                                       Page 6
  360.     ┌──────────────┐
  361.     │  DONATIONS   │
  362.     └──────────────┘
  363.  
  364.     This version of software is free for the taking, but if you feel compelled
  365.     to make a donation, you may send whatever contribution that you feel is
  366.     reasonable to the following address:   
  367.                                            Tom Carroll
  368.                                            1922 W. 4th Avenue
  369.                                            Kennewick, WA  99336
  370.     
  371.     I will be transferring in the spring or summer of 1993.  If you call my
  372.     BBS and do not get an answer, you may leave me mail in one of the networks
  373.     listed above, or contact one of the following three BBS's for a tech
  374.     support account.
  375.     
  376.         The One Stop PCBoard       Arid Acres       The Beta Board
  377.             Gary Hedberg           John Allen         Sam Slade
  378.            (509)943-0211        (509)544-0113/14    (509)375-5720
  379.              (v.32bis)               (v.32)             (v.32)
  380.     
  381.     ┌────────────────┐
  382.     │ACKNOWLEDGEMENTS│
  383.     └────────────────┘
  384.     
  385.     I would like to thank the Tic-2-PCB beta test team.  Without their
  386.     help, this version would not have made it out the door with the quality
  387.     of work that is expected of Dataware Software.
  388.  
  389.     If you see these guys around take a moment to thank them for assisting
  390.     me in the production of a nice utility that ALL PCBoard(tm) sysops may
  391.     use and enjoy!
  392.     
  393.     Fred "Buz" Busteed      The Arcs and Sparks BBS
  394.     Fran To                 Orient Express
  395.     Gary Hedberg            The One Stop PCBoard
  396.     Larry Short             The Computer Gallery
  397.     Anthony Maglietta       The Newtown Express BBS
  398.     
  399.     
  400.     
  401.     
  402.     
  403.     
  404.     
  405.     
  406.     
  407.     
  408.     
  409.     
  410.     
  411.     
  412.     
  413.     
  414.     
  415.     
  416.     
  417.     
  418.     
  419.     Tic-2-PCB v2.2                                                       Page 7
  420.